Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

The XML attribute classCode is fixed to "OBS".

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

The XML attribute moodCode is fixed to "EVN".

Model Attribute Description

The HL7 attribute code uses a code from the ReasonForDocumentNullification vocabulary to describe the reason for nullification.

Implementation in XML Instance

The CV.NPfIT.CDA.Url flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

• The XML attribute code shall contain the code from the ReasonForDocumentNullification vocabulary
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.176"
• The XML attribute displayName shall carry the description associated with the code in the ReasonForDocumentNullification vocabulary
• The XML attribute value of the XML element reference (of the XML element originalText), shall carry a reference element. This can link the coded item to the relevant text in the CDA section

Note, the implementation guidance for the domain where this template is used should be consulted regarding correct usage of the originalText element.

Model Attribute Description

The HL7 attribute effectivetime is used to define the time the reason of the nullification was made.

Only a start date and time must be present for the reason effective time.

(Note this field also represents when the nullification was effective from therefore should equal the time stamp on the document header)

Implementation in XML Instance

The Interval of Points in Time data type flavour is used to carry this information in the XML element effectiveTime using the value attributes of the of the XML elements low and high.

The date range shall be carried as follows:

The XML attribute value of the XML elements low and high, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

• yyyy is the year
• mm is the month
• dd is the day
• hh is the hour
• mm is the minutes
• ss is the seconds
• [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

The Time Interval Complete data type shall be used:

• The XML attribute value of the XML element low shall be populated with a 'start date' time stamp (equivalent to the threshold start time).
• The XML attribute value of the XML element high may be populated with an 'end date' time stamp when the thresholds have a set expiry time and therefore are no longer set for the patient.
  

The XML attribute value of the XML elements low and high should be populated to the level of detail that is available on the sending system.

Model Attribute Description

The HL7 attribute id uses an identifier to identify each instance of an observation of the reason for nullification.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

• The XML attribute root shall contain a DCE UUID.

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCD_TP146049UK05#Reason"